/*
 * File     : IgnoreReturnValue.java
 * Created  : 1 May 2011
 *
 * Copyright © 2011 Matthew Wilson (mj. {my-surname} .uk {at} gmail.com)
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package com.googlecode.dni;

/**
 * <p>
 *  Annotates a method on a native interface that maps to a native function,
 *  indicating that the return value should be ignored.
 * </p>
 * <p>
 *  The actual return type must be specified in the annotation, and the Java
 *  method must be of type <code>void</code>.
 * </p>
 * <p>
 *  It is supposed that this is slightly faster than reading back and parsing
 *  the return result, especially when it is a large, pass-by-value structure.
 * </p>
 *
 * @author Matthew Wilson
 */
public @interface IgnoreReturnValue
{

    // nothing

}
